HPD Retrieval API icon

HPD Retrieval API

1.0.x
(0 reviews)

Get HPD Entity Request

URL: HTTP GET /api/hpdentity/v1/{{ENTITY_TYPE}}/{{ID}}/{{RETURN_TYPE}}

Where:

ENTITY_TYPE (Mandatory) can one of the following:

  • Organization
  • Location
  • Practitioner
  • PractitionerRole

ID (Mandatory) can be the following:

  • HPI ID / CPN e.g. GZZ985-J/FZZ075-G/95ZZHW/R00000368-B
  • HPD GUID e.g. d84992e5-1076-4e8d-bd64-0f7a6d78199c
  • HPD ID e.g. HPDR000000071

RETURN_TYPE (Mandatory) can be one of the following:

  • JsonAttribute
  • FhirAttribute
  • FhirBundleAttribute

SAMPLE REQUESTS

/api/hpdentity/v1/PractitionerRole/ec77b7c5-98b9-4f9c-b804-cbb66dcf8fa7/JsonAttribute
/api/hpdentity/v1/Organization/GZZ985-J/JsonAttribute
/api/hpdentity/v1/Location/FZZ075-G/FhirAttribute
/api/hpdentity/v1/Practitioner/95ZZHW/FhirBundleAttribute

Reviews